home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 090 / newweb.arc / WEB.DOC < prev    next >
Encoding:
Text File  |  1985-08-30  |  16.8 KB  |  494 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.                             WEB COMMAND SHELL  V2.0
  7.  
  8.                                   USER MANUAL
  9.  
  10.                       (C) Copyright 1985 Jonathan Wesener
  11.                              Public Domain Software
  12.  
  13.  
  14.         The  WEB command shell is distributed under the USER-SUPPORTED
  15.  
  16.         concept.  You are encouraged to copy and  share  this  program
  17.  
  18.         with  other  users.   If  you   find the shell useful and want
  19.  
  20.         continued updates and support for this program, please send  a
  21.  
  22.         donation  of  an  amount  you  feel  suitable.   HOWEVER, with
  23.  
  24.         donations of $30 and up you will recieve complete,  documented
  25.  
  26.         source  on  diskette for the latest version of this shell.  By
  27.  
  28.         the way, this was written entirely in Assembler and C.
  29.  
  30.  
  31.         SPECIAL  NOTE:   I  am  not  liable for damages, commercial or
  32.  
  33.         noncommercial, consequential or otherwise  from  use  of  this
  34.  
  35.         program.
  36.  
  37.  
  38.         Also,  if  there are additions, or deletions of commands, etc,
  39.  
  40.         that would make this program easier and  more  useful,  please
  41.  
  42.         write and tell me what they are.
  43.  
  44.  
  45.  
  46.                                                 Jonathan Wesener
  47.                                                 8020 S. Park Rd.
  48.                                                 Wis. Rapids, WI  54494
  49.                                                 August 1985
  50.  
  51.                                                                         0- 0
  52.  
  53.  
  54. CONTENTS:
  55.  
  56. Chapter 0       INSTALLATION
  57.  
  58.         0.1     WEBDEV.SYS ......................................  0-  1
  59.  
  60. Chapter 1       COMMANDS
  61.  
  62.         1.1     ALTer (File Attributes) .........................  1-  1
  63.  
  64.         1.2     CLS (Clear Screen) ..............................  1-  1
  65.  
  66.         1.3     COPY (Files) ....................................  1-  2
  67.  
  68.         1.4     DELete (Files) ..................................  1-  2
  69.  
  70.         1.5     DIRectory (List Files) ..........................  1-  3
  71.  
  72.         1.6     MD (Make Directory) .............................  1-  3
  73.  
  74.         1.7     MEMory (Show memory & Disk Space) ...............  1-  4
  75.  
  76.         1.8     REName (Files) ..................................  1-  4
  77.  
  78.         1.9     RD (Remove directory) ...........................  1-  4
  79.  
  80.         1.10    SD (Set Default) ................................  1-  5
  81.  
  82.         1.11    SET (Symbol) ....................................  1-  5
  83.  
  84.         1.12    SUBmit (Batch File) .............................  1-  6
  85.  
  86.         1.13    TYPE (File) .....................................  1-  6
  87.  
  88.         1.14    QUIT (RETURN TO DOS) ............................  1-  6
  89.  
  90.         1.15    ECHO (Echo line to Standard Output) .............  1-  7
  91.  
  92.         1.16    REM (Remark) ....................................  1-  7
  93.  
  94.  
  95. Chapter 2       HISTORY
  96.  
  97.  
  98. Chapter 3       ODDS AND ENDS
  99.  
  100.         3.1     REDIRECTION .....................................  3-  1
  101.  
  102.         3.2     UPDATES .........................................  3-  1
  103.  
  104.                                                                         0- 1
  105.         INSTALLATION
  106.  
  107.                 Before you use this program, make sure you have the
  108.         character device WEBDEV.SYS on your boot disk and include in
  109.         CONFIG.SYS:
  110.                         device=webdev.sys
  111.  
  112.                 Without this, the command shell will act very strangely
  113.         indeed.  This device is a write only character device which allows
  114.         you to partition the screen into window like areas.  Standard
  115.         output is set to the device WINDOW defined by WEBDEV which controls
  116.         and formats all output to be confined to a portion of the screen.
  117.  
  118.                 You can use this with other programs for windowing effects
  119.         by installing the device as above and then telling the device
  120.         through escape sequences what you want it to do.  The known escape
  121.         sequence are :
  122.  
  123.                 <ESC>A#         - Set display attribute of characters
  124.                 <ESC>C####      - Create a window
  125.                 <ESC>E          - Erase defined window
  126.                 <ESC>P#         - Set display page of the window
  127.  
  128.                 Note: The # sign represents a byte value between 0 - 255.
  129.         For the Create window, the first two numbers represent the upper
  130.         left corner of the window and the second to numbers are the lower
  131.         right corner of the window.
  132.                 If invalid values are give for #, the results will be
  133.                 unpredictable such as giving an invalid page number.
  134.                 ALSO, This device is meant to be used with the screen
  135.                 in the 80X25 modes and the results are unkown for any
  136.                 other mode.
  137.                                                                         1- 1
  138.  
  139.  
  140.         COMMAND - ALTer
  141.  
  142.         PURPOSE - Change file attributes of READ, SYSTEM and HIDDEN.
  143.  
  144.         USAGE   - ALT [Path\]Name /[RHS]
  145.  
  146.         SWITCHES-       R = READ ONLY
  147.                         H = HIDDEN
  148.                         S = SYSTEM
  149.  
  150.         EXAMPLES:  ALT A:\FILE.DAT /H
  151.                    ALT SECRET.FIL /RHS
  152.                    ALT NORM.FIL /
  153.                    ALT FILE.ATT
  154.  
  155.         NOTE:   This command allows you to SET or VIEW the attributes of
  156.         a specified file.  To VIEW the attributes, leave off the switch.
  157.         If the file exists the attributes, if any, will be displayed.
  158.  
  159.                 To SET the attributes use the switch followed by zero or
  160.         more of the switch characters.  Zero characters will make the file
  161.         normal.  Invalid switch characters are ignored.
  162.  
  163.  
  164.  
  165.  
  166.         COMMAND - CLS
  167.  
  168.         PURPOSE - Clear the screen and home the cursor.
  169.  
  170.         USAGE   - CLS
  171.  
  172.         NOTE:   This command will not act right if the screen is in a
  173.         graphics mode.
  174.  
  175.                                                                         1- 2
  176.  
  177.         COMMAND - COPY
  178.  
  179.         PURPOSE - Make copies of a file.
  180.  
  181.         USAGE   - COPY [Path]name [Path][name]
  182.  
  183.         EXAMPLES:       COPY A: B:
  184.                         COPY SUBDIR
  185.                         COPY *.OBJ SUBDIR
  186.  
  187.         NOTE:   This command will try to copy the specified files, (wild
  188.         cards are usable) to the specified, or unspecified file.  If no
  189.         destination is specified, the current directory with the files
  190.         previous name are used.
  191.  
  192.         WARNING:  There is a danger of copying a file over itself by a
  193.         command of COPY FILE.DAT with no destination.  This could trash
  194.         your file, so be careful.  Any ideas on how to check for this
  195.         would be appreciated.
  196.  
  197.         ALSO, If the diskette you're copying to is empty, you might have
  198.         problems.  The version of DOS I used has trouble recoginizing
  199.         empty directories, so COPY WEB.DOC A: will not work, but COPY
  200.         WEB.DOC A:\WEB.DOC will.  As soon as there are files on the disk
  201.         DOS starts working, again.
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208.         COMMAND - DEL
  209.  
  210.         PURPOSE - Delete unwanted files from device.
  211.  
  212.         USAGE   - DEL [PATH][name] [/C]
  213.  
  214.         SWITCH  -       C = Confirm files deletion
  215.  
  216.         EXAMPLES:       DEL
  217.                         DEL SUBDIR /C
  218.                         DEL *.OBJ
  219.                         DEL /C DATA.FIL
  220.  
  221.         NOTE:   If no name is specified, the current directory or the
  222.         specified path will be deleted.  If there is ever a TOTAL deletion
  223.         you will be asked (Y/N) are you sure to avoid doing something
  224.         regretable.  If you use the confirm switch, you will be given a
  225.         (Y/N) prompt for each file to be deleted.  This is handy for
  226.         selective purges!
  227.  
  228.                                                                         1- 3
  229.  
  230.         COMMAND - DIR
  231.  
  232.         PURPOSE - List the files in a directory
  233.  
  234.         USAGE   - DIR [PATH][NAME] [/DHW]
  235.  
  236.         SWITCHES-       D = Suppress the listing of Directories
  237.                         H = Show all hidden and system files
  238.                         W = Give four names to a line without statistics
  239.  
  240.         EXAMPLES:       DIR
  241.                         DIR SUBDIR /DH
  242.                         DIR *.OBJ
  243.                         DIR /W *.obj
  244.  
  245.         NOTE:   This is pretty much like the usual DIR command except
  246.         that it doesn't give the listings path, volume name or free
  247.         disk space.  The amount of free disk space can be gotten with
  248.         a different command, namely MEM (1- 4).  The switch can be
  249.         placed in front of or behind the path, this lets you set up
  250.         your own default listing with the SET command, (1- 5).
  251.  
  252.  
  253.  
  254.  
  255.         COMMAND - MD
  256.  
  257.         PURPOSE - Make subdirectory
  258.  
  259.         USAGE   - MD [path]NAME
  260.  
  261.         EXAMPLE:        MD SUBDIR
  262.  
  263.         NOTE:   For more information see SD and RD.
  264.  
  265.                                                                         1- 4
  266.  
  267.         COMMAND - MEM
  268.  
  269.         PURPOSE - Display the current amount of free memory and free
  270.                   disk space on the current drive.
  271.  
  272.         USAGE   - MEM
  273.  
  274.         NOTE:   The current amount of free memory is displayed in bytes
  275.         and in paragraphs.  A paragraph is the smallest amount of memory
  276.         you can allocate from DOS and consists of 16 bytes.
  277.  
  278.  
  279.  
  280.  
  281.  
  282.         COMMAND - REN
  283.  
  284.         PURPOSE - Rename files on a single device.
  285.  
  286.         USAGE   - REN [PATH]name [PATH][NAME]
  287.  
  288.         EXAMPLES:       REN SUBDIR\*.OBJ
  289.                         REN *.OBJ SUBDIR
  290.                         REN FILE1 FILE2
  291.  
  292.         NOTE:   This is almost exactly like copy except that you can't
  293.         rename a file across devices, like a: to b:, and instead of making
  294.         a copy of the file, it moves the file.
  295.  
  296.  
  297.  
  298.  
  299.         COMMAND - RD
  300.  
  301.         PURPOSE - Remove Directory
  302.  
  303.         USAGE   - RD [PATH]name
  304.  
  305.         EXAMPLES:       RD SUBDIR
  306.                         RD a:\SUB1\SUBDIR
  307.  
  308.         NOTE:   A directory cannot be removed if there are files in it,
  309.         or if it is the current default directory.
  310.  
  311.                                                                         1- 5
  312.  
  313.  
  314.         COMMAND - SD
  315.  
  316.         PURPOSE - Set default directory
  317.  
  318.         USAGE   - SD [PATH]
  319.  
  320.         EXAMPLES:       SD
  321.                         SD ..\SUBDIR
  322.                         SD SUBDIR
  323.                         SD A:\SUBDIR
  324.                         SD A:SUBDIR
  325.  
  326.         NOTE:   If no path is specified, the current default setting will
  327.         be returned.  Also, The '..' directory is how you step out of a
  328.         directory once you're in it.  SD .. will take you back one level
  329.         as long as you're not in the root directory.
  330.  
  331.  
  332.  
  333.  
  334.  
  335.         COMMAND - SET
  336.  
  337.         PURPOSE - To display and set symbols to be converted before
  338.                   the command line is interpreted.
  339.  
  340.         USAGE   - SET [SYM] [STRING]
  341.  
  342.         EXAMPLES:       SET
  343.                         SET DIR DIR /W
  344.                         SET CD SD
  345.                         SET DEL DEL /C
  346.                         SET DATA A:\DATA\DATA.FIL
  347.                         SET %1 FILE.C
  348.                         SET "DIR
  349.  
  350.         NOTE:   This is probably this shell's biggest feature.  There is
  351.         a 1/2K of memory set aside for a symbol table.  When you enter a
  352.         command at the prompt, each word seperated by white space is
  353.         checked to see if it has an entry in the symbol table, if it does,
  354.         the word is replaced with its string from the table.  This allows
  355.         you to tailor the shell to your own standards.  IF YOU DON'T WANT
  356.         A WORD ON THE COMMAND LINE CONVERTED, precede it with a double
  357.         quote, (").  This is necessary for deleting symbols.  You can also
  358.         include redirection of input and output within a symbol.
  359.  
  360.                 EX 1: displays all the symbols that are defined
  361.                 EX 2: will cause all DIR's to default wide listing
  362.                 EX 3: makes CD behave like the usual command shell command
  363.                 EX 6: One way to pass in arguments to batch files
  364.                 EX 7: How to delete a defined word.
  365.  
  366.                                                                         1- 6
  367.  
  368.         COMMAND - SUB
  369.  
  370.         PURPOSE - Submit batch files
  371.  
  372.         USAGE   - SUB [PATH] name
  373.  
  374.         EXAMPLES:       SUB CC.BAT
  375.                         SUB CC
  376.                         SUB SUBDIR\CC
  377.  
  378.         NOTE:   This command will probably die if the current drive or
  379.         default is changed by a command in the batch file.  This command
  380.         uses the PATH set up in the environment by the usual command shell
  381.         to search for the file if it is not in the current directory.
  382.         This is a simple batch processor which has no errorlevel checking
  383.         or the usual parameter passage.
  384.  
  385.                 However, some information can be sent in via symbols, see
  386.         SET, 1- 5.  ALSO, The batch files do not have to have the .BAT
  387.         extension, although its a good idea for record keeping and the
  388.         batch file name AUTO.WEB is reserved.  If there is a batch file
  389.         named AUTO.WEB in the current default directory when WEB is started
  390.         up,  it will AUTOMATICALLY BE SUBMITTED as if it were the first
  391.         command entered.  This is useful for setting up symbol definitions.
  392.         This is the WEB counterpart to AUTOEXEC.BAT.
  393.  
  394.  
  395.  
  396.  
  397.         COMMAND - TYPE
  398.  
  399.         PURPOSE - Display a specified file to standard output.
  400.  
  401.         USAGE   - TYPE [PATH] NAME
  402.  
  403.         EXAMPLES:       TYPE A:\SUBDIR\DATA.DAT
  404.                         TYPE FILE.C
  405.  
  406.         NOTE:   This is just what you'd expect it to be.
  407.  
  408.  
  409.  
  410.  
  411.         COMMAND - QUIT
  412.  
  413.         PURPOSE - To exit the WEB command shell and return to DOS.
  414.  
  415.         USAGE   - QUIT
  416.  
  417.                                                                         1- 7
  418.  
  419.  
  420.         COMMAND - ECHO
  421.  
  422.         PURPOSE - For batch files to tell what they are doing.
  423.  
  424.         USAGE   - ECHO text
  425.  
  426.  
  427.         COMMAND - REM
  428.  
  429.         PURPOSE - To put comments in batch files for documentation, etc.
  430.  
  431.         USAGE   - REM text
  432.  
  433.                                                                         2- 1
  434.  
  435.  
  436.         HISTORY
  437.                 Another benefit of this shell is a four command history
  438.         which is available at the command prompt.  These work totally
  439.         different than from those of the normal command shell.
  440.  
  441.         KEY DEFS:
  442.  
  443.                 HOME : Go to beginning of prompt
  444.                 END  : Go one character beyond last non white space
  445.                 LFTARR : Move cursor left one character
  446.                 RGTARR : Move cursor right one character
  447.                 PGUP : Move up through previous command list
  448.                 PGDWN: Move down through previous command list
  449.                 DEL  : Del current character
  450.                 INS  : Toggle between insert and exchange mode
  451.                 ESC  : Delete all characters from cursor to end of line.
  452.                 CTRL-LFTARR : Previous word.
  453.                 CTRL-RGTARR : Next word.
  454.  
  455.         NOTE:   The function keys have NO meaning.
  456.  
  457.         This command shell has two command cursors, The usual blinking
  458.         underscore and a white block character.  The white block character
  459.         is for the command line and when it is present, the shell is
  460.         expecting input from you.  The other cursor is in the display
  461.         field and has no real function.
  462.  
  463.                                                                         3- 1
  464.  
  465.         Redirection:
  466.  
  467.                 Yes, WEB has redirection and it works the usual way.
  468.  
  469.                 To redirect standard input, use:
  470.                         <FILE.NAM
  471.                 To redirect standard output, use:
  472.                         >FILE.NAM
  473.  
  474.         NOTE: WEB doesn't support the appending of standard output.
  475.                 So, >>FIL.NAM will NOT WORK.
  476.  
  477.  
  478.  
  479.         UPDATES
  480.  
  481.                 I plan on updating this shell to include new features
  482.         and/or fix any bugs.  Your input is probably the most important
  483.         thing in keeping this going.  I would like responses on the
  484.         following areas:
  485.  
  486.                 A: What should the Maximum size of this program be ?
  487.                 B: What commands should the BATCH processor include ?
  488.                 C: What commands should be expanded or shrunk ?
  489.                 D: What new commands could be added ?
  490.                 E: How can the manual be improved ?
  491.                 F: Do you want the function keys to be programmable ?
  492.                 G: Are there any deadly bugs to be squashed ?
  493.